پرش به مطلب اصلی

Upload Users API

POST /uploadUsers​

Description​

This API endpoint allows an admin to trigger the upload of users. This operation does not require any additional parameters or variables and is used to process a batch user upload.

Request Body​

The request utilizes GraphQL to perform the uploadUsers mutation.

Mutation:​

mutation uploadUsers {
    uploadUsers
}

Variables:​

{}

No variables are required for this mutation.

Response:​

  • Success (200 OK):

    • If the user upload is successful, the response will confirm that the upload operation was triggered.
    {
      "data": {
        "uploadUsers": true
      }
    }

  • Error (4XX/5XX):

    • If there is an issue with the user upload process, the response will include an appropriate error message and status code.

Note:​

Ensure that the platform is correctly configured to handle user uploads. This API should be used by admins with the necessary permissions to manage user data and perform bulk uploads within the platform.